eSubmission of Warranty

Detailed description of API:

Version & Updates

View Previous Revisions

Version	Revision Date	Revision History
1.0	10th Aug 2023	New Release
1.1	11th Apr 2024	Updated the Feature name to eSubmission of Warranty. Updated the Defect Failure code API response structure.
1.2	22nd Aug 2024	Updated response codes
1.3	18th Aug 2024	Updated case sensivity, attached claim submission attribute file.
2.0	13th Jan 2025	New endpoints, creation of both EZ Labor and PIP APIs
2.1	4th Feb 2025	Updated attributes file
2.2	19th Feb 2025	Decommissioned the old URLs and included a warning note, after the connection details section. Added the Smart Alert API and updated Response codes.
2.3	21st Mar 2025	Updated attributes file to 2.0
2.4	26th Jun 2025	Added Request body for Defect Failure API and updated sample request payload
2.5	23rd Sep 2025	Updated Request & Response parameters in Create Claim API with PPP details & Added MPS&TnC and 3 Invoice Report APIs

Version	Revision Date	Revision History
2.6	21st May 2026	Addition of two new request body parameters for claim creation, ZZCLAIM_SUBTYPE and ZZPPP_ETE.Please refer to request description table and sample request body and attribute list section.

Overview

There are eight sub-functions within the Warranty Claim eSubmission API:

• Create Warranty Claims:

Used to initiate a claim request in the CNHi eWarranty system in real-time from the DMS application

• Claims Attachments:

  Used to pass additional attachments (PDF/images) associated with the claim. The same claim number that is generated by the “Create Warranty Claims” is sent as an input to this API. This is currently non mandatory, in future for certain claim types this claim attachment API will be required to send additional documentation

• Defect Failure Code Lookup:

  Used to search and retrieve the Defect codes and Failure codes needed to complete an eWarranty Claim before submission

• EZ Labor:

  Used to determine if a claim can be submitted with "EZ Labor" components to complete an eWarranty Claim before submission.

• PIP Multilevel:

Used to receive the part number and its quantity to request for reimbursement using the VIN and PIP code as input parameters needed to complete an eWarranty Claim before submission.

• Smart Alert:

  The Smart Alert functionality provides feedback to users following claim submission

• PPP-MPSandTnC:

  The purpose of this API is to expose the Master Part Schedule (MPS) along with the associated Terms and Conditions (T&C) PDF files to the Dealer Management System (DMS) via DEP.

• Claim Invoice APIs:

  The purpose of this API is to provide summary report data of claim invoices retrieved from SAP and make this information available to the Dealer Management System (DMS) through the DEP platform. This integration is specifically designed for the NAFTA region. The API returns a list of claim invoices, including key invoice details such as sales organization, accounting company, invoice creation date, and invoice amount. To retrieve the relevant data, the dealer code and a timestamp must be provided as input parameters.

Pre-requisites

Pre-requisites

• Dealer must use their Dealer Portal credentials to authorize API call.
• Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• Each Subscription key is unique to DMS and the environment it belongs to
• Based on the payload (XML/JSON), user to pass the content-type in the header
• User within Ownership Group has accepted CNH's Data Acknowledgement (if located in NAFTA)

Authentication

Authentication

• DMS will pass Basic auth in HTTP header with username/password
• Each DMS provider will have a subscription_key assigned by CNHi team, please reach out to dlnadmssupport@cnh.com for assistance
• The UserID and Password will be set up in the Dealer Portal by the Dealer uniquely for DMS access to interfaces
• DEP API will require subscription_key in HTTP header to identify client

API Format

• REST

The DEP takes care of the format transformations (as needed) to process the request and provide a response to the DMS system. REST format is always suggested for greater simplicity.

Connection Details

CNHi provides two environments:

• CERT / UAT
• Production

Note:

Error: 404 - Resource Not Found

If you encounter the following error message, please verify that the API URLs you are using are correct:

{ "statusCode": "404", "message": "{ "statusCode": 404, "message": "Resource not found" }" }

Create Claim API

Using the CNHi eSubmission - Create Claim API, DMSs can submit a real-time requests to create a Warranty Claim

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/createclaim	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/createclaim	REST	POST

Note: All Request Query Parameters are case sensitive.

Request Description

Name	Params Type	Type	Is Required	Comments
ClaimHeader.DealerCode	Request Body	String	Yes	SAP Dealer Number
ClaimHeader.WorkshopCode	Request Body	String	Yes	Workshop   Code
ClaimHeader.DmsClaimNumber	Request Body	String	Yes	Dealer Claim Number
ClaimHeader.JobOrderNumber	Request Body	String	No	Job Order Number
ClaimHeader.ReferenceDate	Request Body	Date YYYY-MM-DD	Yes	Date on which the   claim was created
ClaimHeader.CnhClaimNumber	Request Body	String	No	CNH Claim Number -Only   necessary for resubmitting claims that were previously assigned a CNH claim   number.
ClaimHeader.SerialNumber	Request Body	String	Yes	Vehicle Identification Number (VIN)
ClaimHeader.VehicleHours	Request Body	String	Yes	Vehicle Hours - Current   Usage Measurement on the Vehicle
ClaimHeader.WorkshopEntryDate	Request Body	Date YYYY-MM-DD		Workshop Entry Date (Failure Date)
ClaimHeader.WorkshopLeaveDate	Request Body	Date YYYY-MM-DD		Workshop Leave Date   (Repair Date)
ClaimHeader.TimeIn	Request Body	String		Time In (Time when unit entered)
ClaimHeader.TimeOut	Request Body	String		Time Out (Time   when unit exit workshop)
ClaimHeader.InstalledDate	Request Body	String		Installed Date (Invoice / Installation date of the spare   part)
ClaimHeader.AmountUseSparePart	Request Body	String		Amount of Use on   Spare Part (Unit usage at Invoice / Installation date)
ClaimHeader.SparePartInvoiceNumber	Request Body	String		Spare Part Invoice Number (For Spare Parts   warranty: Invoice number)
ClaimHeader.AuthorizationNumber	Request Body	String		Authorization Number   (pre-authorization code)
ClaimHeader.Assessment	Request Body	String		Self-Assessment / non-self-assessment
ClaimHeader.FailedComponentSerial	Request Body	String		Failed Component Serial   Number
ClaimHeader.ReplacedComponentSerial	Request Body	String		Replaced Component Serial Number
ClaimHeader.RepairStartDate	Request Body	Date YYYY-MM-DD		Repair Start Date
ClaimHeader.Failure.WarrantyType	Request Body	String		Warranty Type     NAFTA Specific Options     A: Base Warranty     B: Extra Base     C: Service Policy     D: Spare Parts Warranty     E: Emissions     G: Extra Base (NAFTA Use Case)     H: Campaign     I: Extended Warranty     J: Dealer Demo     K: Breakdown Assistance (BDA)     L: Base Warranty – Rent to Own Unit (Construction Calls)     M: Case ProCare Maintenance Program     N: Non-serialized Attachment Warranty     P: Ultrashield Inspection     Q: Major Assembly Parts Warranty     T: Sales Policy     V: CNH Company Demo     W: Wholegoods Shortage     Y: PPP (used for NAFTA only)     Z: P.D.I.     0: Planned Maintenance     3: High Voltage Components (EV)     5: EV Batteries
ClaimHeader.Failure.SupplierCode	Request Body	String		Supplier Code (Default   to ‘000’)
ClaimHeader.Failure.CampaignNumber	Request Body	String		CNH assigned PIP/ Campaign/Recall number
ClaimHeader.Failure.ComponentCode	Request Body	String		Component Code (Code   that identifies the component that failed. Dealer selects appropriate code   from CNH SRT Information)
ClaimHeader.Failure.FailureCode	Request Body	String		Failure code
ClaimHeader.Failure.FailureSeverityRating	Request Body	String		Failure Severity Rating   (Code that indicates the failure severity)
ClaimHeader.Failure.FailureDescription	Request Body	String		Failure Description
ClaimHeader.Failure.ServiceParticipation	Request Body	String		Service   Participation
ClaimHeader.Failure.laborWU	Request Body	Decimal		Labor Working Units
ClaimHeader.Failure.ezLaborUniqueID	Request Body	GUID		Unique ID Code to   identify each EZ Labor call
ClaimHeader.Failure.zzpolicyNo	Request Body	String		PPP Policy Number
ClaimHeader.Failure.recordId	Request Body	String		Record Id
ClaimHeader.Failure.FailureComplaint.RowNumber	Request Body	String		Progressive Row Number "01" to   "99"
ClaimHeader.Failure.FailureComplaint.RowText	Request Body	String		Complaint Text
ClaimHeader.Failure.FailureCause.RowNumber	Request Body	String		Progressive Row Number "01" to   "99"
ClaimHeader.Failure.FailureCause.RowText	Request Body	String		Cause Text
ClaimHeader.Failure.FailureCorrection.RowNumber	Request Body	String		Progressive Row Number "01" to   "99"
ClaimHeader.Failure.FailureCorrection.RowText	Request Body	String		Correction Text
ClaimHeader.Failure.FailureComplications.RowNumber	Request Body	String		Progressive Row Number "01" to   "99"
ClaimHeader.Failure.FailureComplications.RowText	Request Body	String		Complications   Text
ClaimHeader.Failure.FailureSpecialInstructions.RowNumber	Request Body	String		Progressive Row Number "01" to   "99"
ClaimHeader.Failure.FailureSpecialInstructions.RowText	Request Body	String		Special   Instructions Text
ClaimHeader.Failure.ItemPosition.PositionCategory	Request Body	String		Position Category (Type of Position)
ClaimHeader.Failure.ItemPosition.MaterialCode	Request Body	String		Material Code
ClaimHeader.Failure.ItemPosition.Quantity	Request Body	String		Quantity (Claimed Quantity for the Position)
ClaimHeader.Failure.ItemPosition.ClaimedAmount	Request Body	Decimal		Claimed Amount   for the Position
ClaimHeader.Failure.ItemPosition.AmountCurrency	Request Body	String		Currency of Claim Amount
ClaimHeader.Failure.ItemPosition.OperationDescription	Request Body	String		Operation   Description
ClaimHeader.Failure.ItemPosition.DrawingDescription	Request Body	String		Drawing Description
ClaimHeader.Failure.ItemPosition.ThirdPartyInvoiceNumber	Request Body	String		Third Party Invoice   Number for the Claimed External Work Amount
ClaimHeader.Failure.ItemPosition.ZznoncnhMatnr	Request Body	String		PPP Non-CNH Mat Number
ClaimHeader.Failure.ItemPosition.ZznoncnhDesc	Request Body	String		PPP Non-CNH Description
ClaimHeader.zzphoneNo	Request Body	String		PPP Phone Number
ClaimHeader.zzemail	Request Body	String		PPP email
ClaimHeader.zznonCnhSerialNo	Request Body	String		PPP Non-CNH Serial Number
ClaimHeader.zzcnhSoldUnit	Request Body	String		PPP CMH Sold Unit
ClaimHeader.zzrefclaimno	Request Body	String		PPP Ref Claim Number
ClaimHeader.zzbaseRefClmno	Request Body	String		PPP Base Ref Claim   Number
ClaimHeader.zzttmId	Request Body	String		PPP TTM Id
ClaimHeader.zzcoverage	Request Body	String		PPP Coverage
ClaimHeader.zzclaim_subtype	Request Body	String		Saf-t-Cab PPP
ClaimHeader.zzppp_ete	Request Body	String		ETE contract
smartAlertFlag	Request Body	String		Smart Alert Flag
attachmentFlag	Request Body	String		Attachment Flag
language	Request Body	String		Language

Warranty Claim eSubmission Attributes

Download Warranty Claim Submission Attributes

JSON Request Body Sample

Download Create Claim JSON Sample Request Body

Response Description

Name	Type	Description
dealer_code	String	Dealer Code
workshop_code	String	Workshop Code
dms_claim_number	String	DMS Claim Number
job_order_number	String	Job Order Number
reference_date	String	Reference Date
cnh_claim_number	String	CNH Claim Number
serial_number	String	Serial Number
van_code	String	Van Code
dealer_name	String	Dealer Name
status	String	Status
status_description	String	Status description
claimed_value	String	Claimed Value
reimbursed_value	String	Reimbursed Value
currency	String	Currency
message	Array	Message
message.row_number	String	Row Number
message.row_text	String	Row Description
zzext_clmno	String	Assurant Claim Number

JSON Response Sample

Download Create Claim JSON Response Sample

Claim Processing / Attachment API

This is used to pass additional attachments (PDF/images) associated with the claim. The same claim number that is generated by the Create Claim API is sent as an input to this API.

• Claim Attachment POST API can upload an attachment (document or image) for submitted claim.
• Claim Attachment GET API can retrieve the same attachment using required parameters (like attname, atttype and objkey).

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/attachment	REST	POST
	https://{base_url}/external/services/warrantyclaim/attachment	REST	GET
Production	https://{base_url}/external/services/warrantyclaim/attachment	REST	POST
	https://{base_url}/external/services/warrantyclaim/attachment	REST	GET

Request Description

Note: All Request Query Parameters are case sensitive.

Name	Params Type	Type	Is Required	Comments
attname	Query	string	false	Name of the attachment
sap-client	Query	string	false	Sap-Client (fixed value "602")
atttype	Query	string	false	Media Type (jpeg or pdf)
objkey	Query	string	false	CNH Claim number

Request Body

Method	Name	Type	Description
POST	Request Body	"Image/jpeg" or “application/pdf"	Required attachment should be uploaded as image or document in the request body. It can be "image/jpeg" for an image, "application/pdf" for a pdf document.
GET	Request Body		Request body not required

Response Description

{
  "statuscode": "200",
  "message": "Claim Processing Completed."
}

Status Code	Message
200	"Claim Processing Completed."

Claim Processing / Attachment GET API

The uploaded document will be retrieved based on the query parameter as response.

Sample PDF Claim Attachment Request

Download Claim Attachment PDF Sample

Sample JPEG Claim Attachment Request

Download Claim Attachment JPEG Sample

Defect Failure Code API

This is used to search and retrieve the Defect and Failure codes needed to complete an eWarranty Claim before submission.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/defectfailure	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/defectfailure	REST	POST

Note: All Request Query Parameters are case sensitive.

Request Body

Name	Type	Description	Sample
ZcnWtClaimLookupEw20.DefCodeGroup	Char100	Defect Code Group. (complete or partial code, insert * in case to pull all the next level information)	10
ZcnWtClaimLookupEw20.DefCodeSub	Char100	Defect Code Sub group (complete or partial code, insert * in case to get all the information in next level)	10102
ZcnWtClaimLookupEw20.DefCodeSubSub	Char100	Defect Code Sub Sub group (complete or partial code, insert * in case to get all the information)	10102AK
ZcnWtClaimLookupEw20.DefDescGroup	Char100	Defect Description Group (complete or partial, Insert * in case to pull all the next level information)	Engine
ZcnWtClaimLookupEw20.DefDescSub	Char100	Defect Description Sub group(complete or partial code, insert * in case to get all the information in next level)	Pan and covers
ZcnWtClaimLookupEw20.DefDescSubSub	Char100	Defect Description SubSub Group(complete or partial code, insert * in case to get all the information in next level)	ENGIN BLOCK COVER
ZcnWtClaimLookupEw20.FailCode	Char100	Failure code (to lookup the list of failure code & description)	001
ZcnWtClaimLookupEw20.FailDesc	Char100	Failure description (to lookup the list of failure)	SPECIAL INSPECTION CHECKS
ZcnWtClaimLookupEw20.IRelobExt	Char100	Serial number. It is included in order to reduce the number of responses	HAJF9N4LCMG247385
ZcnWtClaimLookupEw20.Lang	Char1	Language ( for both defect & failure)	E (English)

JSON Request Body Sample

Download Defect Code JSON Sample Request Body

Response Description

Name	Type	Description
ZcnWtClaimLookupEw20Response.ToutDefect	Object	Defect
ZcnWtClaimLookupEw20Response.ToutDefect.Item.Code	String	Defect Code
ZcnWtClaimLookupEw20Response.ToutDefect.Item.Description	String	Defect Description
ZcnWtClaimLookupEw20Response.ToutFailure	Object	Failure
ZcnWtClaimLookupEw20Response.ToutFailure.Item.Code	String	Failure Code
ZcnWtClaimLookupEw20Response.ToutFailure.Item.Description	String	Failure Description
ZcnWtClaimLookupEw20Response.ToutMaterial	Object	Material
ZcnWtClaimLookupEw20Response.ToutMaterial.Item.MatCode	String	Material Code
ZcnWtClaimLookupEw20Response.ToutMaterial.Item.MaterialDescription	String	Material Description
ZcnWtClaimLookupEw20Response.ToutOperation	Object	Operation
ZcnWtClaimLookupEw20Response.ToutOperation.Item.MatCode	String	Failure Code
ZcnWtClaimLookupEw20Response.ToutOperation.Item.MaterialDescription	String	Failure Description

JSON Response Sample

Download Defect Failure JSON Response Sample

Claim Processing / Attachment GET API

The uploaded document will be retrieved based on the query parameter as response.

Sample PDF Claim Attachment Request

Download Claim Attachment PDF Sample

Sample JPEG Claim Attachment Request

Download Claim Attachment JPEG Sample

EZ Labor API

A DMS will call the EZ Labor API during the claim creation process passing the necessary request parameters. This operation determines whether a claim can be submitted with only "EZ Labor" as a single line item for all labor, or if it requires Standard Repair Times to break down the labor into multiple line items.

The API will respond with an indicator of availability for EZ Labor, along with additional details, including a unique ID number associated with the request. This unique ID will be used to validate the EZ Labor amount during the claim submission process.

If the EZ Labor feature is activated within a claim creation, a new field labeled "labor work unit" will appear in the claim submission interface under the failure section.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/ezlabor	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/ezlabor	REST	POST

Note: All Request Query Parameters are case sensitive.

JSON Request Body Sample

Download EZ Labor JSON Sample Request Body

Response Description

Name	Type	Description
message	Char	Message ID (Error/Successful) – S/E
message_text	String	Message Description – “”
ez_result	String	Ez Labor feedback (Ok/ KO) – YES/NO
ez_reason	String	Reason of ok/ko feedback from Ezlabor
ez_labor_code	String	Labor code based on feedback
ez_labor_time	String	Material
ez_unique_id	GUID	Unique ID code to identify each EZLabor call
ez_freeze_wu	Decimal	Work order labor inserted by dealer in DMS
ez_attempts	String	Number of attempts remaining before freezing Labor WU field
ez_attempts_message		Message to be displayed to show number of attempts left
table_defect	Array	List of Defect
table_defect.defect_code	String	Defect Code Number
table_defect. defect_description	String	Defect Code Description

JSON Response Sample

Download EZ Labor JSON Response Sample

PIP Multilevel API

When a dealer is about to create a claim, it's essential to identify if the vehicle is included in a Product Improvement Program (PIP) campaign. The PIP Multilevel feature in eWarranty enables dealers to prefill the content for warranty type H (PIP) by selecting the relevant PIP code. By utilizing this feature, the DMS will receive the part number and quantity needed to request reimbursement using the VIN and PIP code as input parameters during claim submission.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/pipmulti	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/pipmulti	REST	POST

Note: All Request Query Parameters are case sensitive.

JSON Request Body Sample

Download PIP Multilevel JSON Sample Request Body

Response Description

Name	Type	Description
Message	Char	Message id (Error/Successful) – S/E
message_text	String	Message Description – “”
table_results	Array	List of Items
table_results.defect_code	String	Defect Code
table_results.pip_code	String	PIP (Product Improvement Program) Code
table_results.levelid	String	PIP Level IF
table_results.mandatory	Char	Flag to identify mandatory items for PIP Code
table_results.material_type	String	Material Type (Item Category)
table_results.material_code	String	Material Number
table_results.material_quantity	Decimal	Material Quantity (Item Quantity)

JSON Response Sample

Download PIP Multi JSON Response Sample

Smart Alert API

The Smart Alert functionality provides feedback to users following claim submission. The feedback will be sourced from CNH, and based on a specific algorithm, two types of feedback will be generated and sent to DMS via DEP:

1. OK Feedback: Indicates that no issues have been found and the claim has been successfully submitted without any problems.

2. Alert Feedback: Highlights fields that require the user’s attention. In this case, the user has the option to either edit the claim or disregard the alert.

To enable the Smart Alert functionality, DMS should call the new Claim Status Inquiry Web Service exposed by DEP immediately after the claim submission.

This is used to search and retrieve the Defect and Failure codes needed to complete an eWarranty Claim before submission.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/smartalert	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/smartalert	REST	POST

Note: All Request Query Parameters are case sensitive.

JSON Request Body Sample

Download Smart Alert JSON Sample Request Body

The service can be called by inserting the input following the combination of data:

1. Claim number.

2. Dealer code & user & date from & date to

Response Description

Name	Type	Description	Example
message_id	CHAR 1	Id (Success or Error)	E, S
message_text	CHAR 250	Message Description	Please fill all the mandatory data to call the service
table_results	Array	List of Items
table_results.cnh_claim_number	CHAR 12	Serial Number	202020202020
table_results.dealer_code	CHAR 10	Dealer Code	0000123456
table_results.serial_number	CHAR 35	VIN Inserted by Dealer	HCCZFA10HMCJ11111
table_results.status	CHAR 4	Status of Warranty Claim	80
table_results.status_description	CHAR 40	Description of Warranty Claim	CLAIM CANCELLED, CLAIM PAID, DRAFT, AWAITING ADDITIONAL DEALER INFO, CLAIM CANCELLED/REPLACED
table_results.failure_date	DATE 8	Date In	2024-05-20
table_results.creation_date	DATE 8	Date of Application	2024-05-23
table_results.smart_alert_feedback	CHAR 1500	Feedback

JSON Response Sample

Download Smart Alert JSON Response Sample

PPP-MPSandTnC

The purpose of this API is to expose the Master Part Schedule (MPS) along with the associated Terms and Conditions (T&C) PDF files to the Dealer Management System (DMS) via DEP.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/ppp/mpsandtnc	REST	GET
Production	https://{base_url}/external/services/warrantyclaim/ppp/mpsandtnc	REST	GET

Note: All Request Query Parameters are case sensitive.

Request Description

Name	Params Type	Type	Is Required	Comments
serialnumber	Query	String	Yes	VIN / Serial Number
mps_tc_indicator	Query	String	Yes	MPS & TC Indicator Allowed Values (M & T) M – Master Parts Schedule T – Term and Conditions

Response Description

The API responds with Master Part Schedule (MPS) along with the associated Terms and Conditions (T&C) PDF file based on the mps_tc_indicator.

PDF Response Samples

Download Sample PURCHASED PROTECTION PLAN MASTER PARTS SCHEDULE
Download Sample PURCHASED PROTECTION PLAN TERMS AND CONDITIONS

PPP Claim Invoice Reports

Invoice Summary Report

The purpose of this API is to provide summary report data of claim invoices retrieved from SAP and make this information available to the Dealer Management System (DMS) through the DEP platform. This integration is specifically designed for the NAFTA region. The API returns a list of claim invoices, including key invoice details such as sales organization, accounting company, invoice creation date, and invoice amount. To retrieve the relevant data, the dealer code and a timestamp must be provided as input parameters.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/invoicesummaryreport	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/invoicesummaryreport	REST	POST

Note: All Request Query Parameters are case sensitive.

Request Body description

Name	Params Type	Type	Is Required	Comments
DEALER_NUMBER	Request Body	String	Yes	Dealer Number
SALES_ORG	Request Body	String	No	Sales Organization
BRAND	Request Body	String	No	Brand
DIVISION	Request Body	String	No	Division
INVOICE_FROM_DATE	Request Body	String	Yes	Invoice From Date
INVOICE_TO_DATE	Request Body	String	Yes	Invoice To Date

JSON Request Body Sample

Download Invoice Summary Report JSON Sample Request Body

Response Description

Name	Type	Description	Example	Comments
ZcnWtDmsInvoiceSummaryResponse.Summary.dealerCode	Integer	Dealer Code	111111	Dealer Number
ZcnWtDmsInvoiceSummaryResponse.SummarysalesOrg	String	Sales Organization	G183	Sales Organization
ZcnWtDmsInvoiceSummaryResponse.Summary.brand	String	Brand	CS AG	Brand
ZcnWtDmsInvoiceSummaryResponse.Summary.division	String	Division		Division
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.zzwtybbukrs	String	Company Code / Sales Organization	G182	Invoice From Date
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.zzwtybelnr	String	Accounting document	0040630926	Invoice To Date
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.zzwtygjahr	Integer	Fiscal year	2025
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.budat	Date	Invoice posting date	2025-01-09
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.wrbtr	Decimal	Invoice net amount	3224.41
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.waers	String	Currency	USD
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.xblnr	String	Reference doc	C5150972A8
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.zzclaimdealer	String	Claim Number	57112V4S
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.parnr	String	Partner code	110935
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.partx	String	Partner Name	Hoober, Inc.
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.zinvoicekey	Integer	Invoice Key	2
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.znoteprntdt	Date	Posting Date	2025-01-09
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceList.bldat	Date	Document Date	2025-01-09
ZcnWtDmsInvoiceSummaryResponse.Summary.returnMessages.Type	String	Type	S / E
ZcnWtDmsInvoiceSummaryResponse.Summary.returnMessages.Message	String	Message	Successful
ZcnWtDmsInvoiceSummaryResponse.Summary.returnMessages.Number	Integer	Number	14
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceInfo.invoiceSelected	Integer	Invoice Selected	0
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceInfo.wrbtrTot	Decimal	wrbtrTot	6209.7
ZcnWtDmsInvoiceSummaryResponse.Summary.invoiceInfo.waers	String	Waers	CAD

JSON Response Sample

Download Invoice Summary Report JSON Response Sample

Invoice Daily Report

The purpose of this API is to retrieve a daily list of claim invoices, including key header and detail information, sourced from SAP. This integration is specific to the NAFTA region. By leveraging the daily report, the Dealer Management System (DMS) can consume both invoice header and line-item details. The API requires the dealer number as an input parameter to fetch the relevant data.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/invoicedailyreport	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/invoicedailyreport	REST	POST

Note: All Request Query Parameters are case sensitive.

Request Body description

Name	Params Type	Type	Is Required	Comments
DEALER_NUMBER	Request Body	String	Yes	Dealer Number
SALES_ORG	Request Body	String	No	Sales Organization
BRAND	Request Body	String	No	Brand
DIVISION	Request Body	String	No	Division
INVOICE_DATE	Request Body	String	Yes	Invoice Date

JSON Request Body Sample

Download Invoice Daily Report JSON Sample Request Body

Response Description

Name	Type	Description	Example
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceHeader.zzwtybbukrs	String	Company Code / Sales Organization	G182
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.zzwtybelnr	String	Accounting document	0040630926
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.zzwtygjahr	Integer	Fiscal year	2025
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.budat	Date	Invoice posting date	2025-01-09
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.wrbtr	Decimal	Invoice net amount	3224.41
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.waers	String	Currency	USD
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.xblnr	String	Reference doc	C5150972A8
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.zzclaimdealer	String	Claim Number	57112V4S
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.parnr	String	Partner code	110935
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.partx	String	Partner Name	Hoober, Inc.
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.zinvoicekey	Integer	Invoice Key	2
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.znoteprntdt	Date	Posting Date	2025-01-09
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport. invoiceHeader.bldat	Date	Document Date	2025-01-09
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.mandt	String	mandt	602
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zzwtybbukrs	String	Company Code	G183
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zzwtybelnr	String	Accounting document	C5150972A8
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zzwtygjahr	Integer	Fiscal Year	2025
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.pnguid	GUID	Internal Number	4683D733DF031FD084AA140399A0850F
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.pncnt	Integer	Counter	1
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.kunnr	String	Customer	0000120119
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.clmno	String	Claim Number	202500006190
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.clmty	String	Warranty claim type	ZW03
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.parnr	String	Partner	0000120119
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zzvparnr	String	Partner	0000112520
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.parvw	String	Partner Role	AG
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zzclaimdealer	String	Dealer Claim number	265182
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.relobext	String	External object number	YDG222373
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail. zzwtyveicolo	String	Internal vehicle no	0012031214
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.refdt	Date	Reference Date	2025-03-20
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.astate	Date	Processing Status	Z080
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.blart	String	Document Type	E3
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.bldat	Date	Document Date	2025-04-04
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.budat	Date	Posting Date	2025-04-04
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.monat	Integer	Period	4
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.xblnr	String	Reference	0031692272
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.waers	String	Currency	USD
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.partx	String	Name	HOOBER, INC.
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.spras	String	Language	E
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.vkorg	String	Sales Org.	G183
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.vtweg	String	Distribution channel	CS
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.spart	String	Segment	AG
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zvalmat	Decimal	Total expense	2,302.76
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zvallav	Decimal	Total expense	330.00
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zvalsubl	Decimal	Total expense	0
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.rejcd	String	Decision	SRET_ADD
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.oldcn	String	Preceding Claim	202500099739
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zwtaiva	Decimal	Percent	0
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zwtiiva	Decimal	VAT Aumont (DC)	0
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.kursf	Decimal	Exchange Rate	1.00000
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.wrbtr	Decimal	Net Aumont	330.00
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.statuswebui	String	Status web UI	0
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.statuswebuidsc	String	Status web UI description
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zinvoicekey	Integer	Invoice key	1
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.invoiceDetail.zzextclmno	String	PPP external Claim number
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.returnMessages.Type	String	Type	S / E
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.returnMessages.Message	String	Message	Successful
ZcnWtDmsInvoiceDlyReportResponse.Dailyreport.returnMessages.Number	Integer	Number	14

JSON Response Sample

Download Invoice Daily Report JSON Response Sample

Invoice Detail Report

The purpose of this API is to retrieve detailed information for a specific invoice, with data sourced from SAP. This integration is intended for the NAFTA region. The Invoice Detail API enables the Dealer Management System (DMS) to access both the header and line-item details of a given invoice. To query this information, the API requires the sales organization code, invoice number, and invoice year as input parameters.

Environment	URL	API	Request Type
CERT/UAT	https://{base_url}/external/services/warrantyclaim/invoicedetailreport	REST	POST
Production	https://{base_url}/external/services/warrantyclaim/invoicedetailreport	REST	POST

Note: All Request Query Parameters are case sensitive.

Request Body description

Name	Params Type	Type	Is Required	Comments
COMPANY_CODE	Request Body	String	Yes	Company Code
ACC_DOC_NBR	Request Body	String	Yes	Invoice Number
ACC_DOC_YEAR	Request Body	Integer	Yes	Invoice Year

JSON Request Body Sample

Download Invoice Detail Report JSON Sample Request Body

Response Description

Name	Type	Description	Example
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.zzwtybbukrs	String	Company Code / Sales Organization	G182
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.zzwtybelnr	String	Accounting document	0040630926
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.zzwtygjahr	Integer	Fiscal year	2025
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.budat	Date	Invoice posting date	2025-01-09
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.wrbtr	Decimal	Invoice net amount	3224.41
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.waers	String	Currency	USD
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.xblnr	String	Reference doc	C5150972A8
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.zzclaimdealer	String	Claim Number	57112V4S
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.parnr	String	Partner code	110935
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.partx	String	Partner Name	Hoober, Inc.
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.zinvoicekey	Integer	Invoice Key	2
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.znoteprntdt	Date	Posting Date	2025-01-09
ZcnWtDmsInvoiceDetailResponse.detail.invoiceHeader.bldat	Date	Document Date	2025-01-09
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.mandt	String	mandt	602
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zzwtybbukrs	String	Company Code	G183
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zzwtybelnr	String	Accounting document	C5150972A8
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zzwtygjahr	Integer	Fiscal Year	2025
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.pnguid	GUID	Internal Number	4683D733DF031FD084AA140399A0850F
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.pncnt	Integer	Counter	1
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.kunnr	String	Customer	0000120119
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.clmno	String	Claim Number	202500006190
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.clmty	String	Warranty claim type	ZW03
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.parnr	String	Partner	0000120119
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zzvparnr	String	Partner	0000112520
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.parvw	String	Partner Role	AG
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zzclaimdealer	String	Dealer Claim number	265182
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.relobext	String	External object number	YDG222373
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail. zzwtyveicolo	String	Internal vehicle no	0012031214
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.refdt	Date	Reference Date	2025-03-20
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.astate	Date	Processing Status	Z080
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.blart	String	Document Type	E3
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.bldat	Date	Document Date	2025-04-04
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.budat	Date	Posting Date	2025-04-04
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.monat	Integer	Period	4
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.xblnr	String	Reference	0031692272
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.waers	String	Currency	USD
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.partx	String	Name	HOOBER, INC.
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.spras	String	Language	E
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.vkorg	String	Sales Org.	G183
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.vtweg	String	Distribution channel	CS
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.spart	String	Segment	AG
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zvalmat	Decimal	Total expense	2,302.76
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zvallav	Decimal	Total expense	330.00
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zvalsubl	Decimal	Total expense	0
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.rejcd	String	Decision	SRET_ADD
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.oldcn	String	Preceding Claim	202500099739
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zwtaiva	Decimal	Percent	0
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zwtiiva	Decimal	VAT Aumont (DC)	0
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.kursf	Decimal	Exchange Rate	1.00000
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.wrbtr	Decimal	Net Aumont	330.00
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.statuswebui	String	Status web UI	0
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.statuswebuidsc	String	Status web UI description
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zinvoicekey	Integer	Invoice key	1
ZcnWtDmsInvoiceDetailResponse.detail.invoiceDetail.zzextclmno	String	PPP external Claim number
ZcnWtDmsInvoiceDetailResponse.detail.returnMessages.Type	String	Type	S / E
ZcnWtDmsInvoiceDetailResponse.detail.returnMessages.Message	String	Message	Successful
ZcnWtDmsInvoiceDetailResponse.detail.returnMessages.Number	Integer	Number	14

JSON Response Sample

Download Invoice Detail Report JSON Response Sample

Response Codes

Status Code	Message
200	Claim Processing Completed.
400	Required request body missing error!
	1. Required request body missing error!
	2. Invalid Content-Type / format
	3. Invalid json format in the request body!
	4. Invalid json format in the request body!
	5. E Please Check - User Is Not Setup as Active in Customer_CS table
	6. E Dealer does not have sales area for this product.
	7. E Invalid Vehicle Hours << Submitted Vehicle Hours>>, not coherent with meas point hours << valid Hours>>
422	1. Data related error / warning message
	2. Please, fill all mandatory data to call the service.
	3. No claims found based on input parameters
500	Internal Server Error
401	Access denied due to invalid credentials!